Added README.xen-bugtool.
authoremellor@leeni.uk.xensource.com <emellor@leeni.uk.xensource.com>
Mon, 28 Nov 2005 12:20:33 +0000 (12:20 +0000)
committeremellor@leeni.uk.xensource.com <emellor@leeni.uk.xensource.com>
Mon, 28 Nov 2005 12:20:33 +0000 (12:20 +0000)
Signed-off-by: Ewan Mellor <ewan@xensource.com>
docs/README.xen-bugtool [new file with mode: 0644]

diff --git a/docs/README.xen-bugtool b/docs/README.xen-bugtool
new file mode 100644 (file)
index 0000000..a7e95ef
--- /dev/null
@@ -0,0 +1,16 @@
+xen-bugtool
+===========
+
+The xen-bugtool command line application will collate the Xen dmesg output,
+details of the hardware configuration of your machine, information about the
+build of Xen that you are using, plus, if you allow it, various logs.
+
+The information collated can either be posted to a Xen Bugzilla bug (this bug
+must already exist in the system, and you must be a registered user there), or
+it can be saved as a .tar.bz2 for sending or archiving.
+
+The collated logs may contain private information, and if you are at all
+worried about that, you should not use this tool, or you should explicitly
+exclude those logs from the archive.
+
+xen-bugtool is wholly interactive, so simply run it, and answer the questions.